Pool docs #565
Merged
Pool docs #565
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #565 +/- ##
=======================================
Coverage 99.57% 99.57%
=======================================
Files 16 16
Lines 1398 1400 +2
=======================================
+ Hits 1392 1394 +2
Misses 6 6
Continue to review full report at Codecov.
|
mcollina
reviewed
Feb 24, 2021
ronag
approved these changes
Feb 24, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I know this page might seem redundant, but I think it is the best way to document
Pool. This clearly shows the user what methods, properties, and events are available to them, and provides easy links to the relevant part of theClientdocumentation.Reviewers:
If there is anything specific we should highlight for any of the properties or methods in regards to descriptions we should include that. For example, we may want to include descriptions for properties like
pending,busy, etc. specifying how they are evaluated for the pool of clients.